Skip to main content

Reaction Roles

The Reaction Roles system allows you to set up interactive button-based roles that members can assign to themselves by clicking on buttons. This guide explains how to use the /reaction-roles command to create, manage, and customize reaction roles for your Discord server.

Command Overview​

/reaction-roles button create​

This command lets you create a set of button-based reaction roles. You can define up to five roles, each with its own button text, style, and behavior.

Command Syntax​

/reaction-roles button create [role-1:role] [role-1-text:"text"] [role-1-style:style] ...

Options Explained in Detail​

The system is built around grouped options for each button. Each button corresponds to a specific role and its associated settings. For example, all settings that start with role-1 relate to the first button, while those starting with role-2 relate to the second, and so on.

Option Groups​

  1. role-[number]

    • Description: The actual role that users will receive when they click the button.
    • Type: Role
    • Required: role-1 is always required to create at least one button. role-2, role-3, etc., are optional if you want to create additional buttons.
    • Example: role-1:@Gamer

  2. role-[number]-text

    • Description: The text displayed on the button. This text helps users understand what role they are assigning to themselves.
    • Type: String
    • Required: Optional. If not provided, the button will display the default role name.
    • Example: role-1-text:"Join Gamers"

  3. role-[number]-style

    • Description: The color and style of the button. This makes it visually distinct and can help convey importance or context.
    • Type: String
    • Choices:
      • Primary: Blue
      • Secondary: Gray
      • Success: Green
      • Danger: Red
    • Required: Optional. If not provided, the default style is Primary (blue).
    • Example: role-1-style:"SUCCESS"

How These Groups Work Together​

Each role has its own set of related options:

  1. role-1 defines the first role. You can add optional settings like:
    • role-1-text: Custom text for the button.
    • role-1-style: Color of the button.
  2. Similarly, role-2, role-3, etc., define additional roles and their respective settings.

For example:

/reaction-roles button create [role-1:@Gamer] [role-1-text:"Join Gamers"] [role-1-style:"SUCCESS"]

This command creates a single green button labeled "Join Gamers" that assigns the @Gamer role.

If you want more buttons, add the next group of options:

/reaction-roles button create [role-1:@Reader] [role-1-text:"Book Club"] [role-1-style:"PRIMARY"] [role-2:@Artist] [role-2-text:"Art Club"] [role-2-style:"SUCCESS"]

This command creates:

  1. A blue button labeled "Book Club" that assigns the @Reader role.
  2. A green button labeled "Art Club" that assigns the @Artist role.

Example Commands​

Create a Single Reaction Role​

/reaction-roles button create [role-1:@Gamer] [role-1-text:"Join Gamers"] [role-1-style:"SUCCESS"]
  • Creates a single button that:
    • Assigns the @Gamer role when clicked.
    • Displays "Join Gamers" as the button text.
    • Uses the green button style.

Create Multiple Reaction Roles​

/reaction-roles button create [role-1:@Reader] [role-1-text:"Book Club"] [role-1-style:"PRIMARY"] [role-2:@Artist] [role-2-text:"Art Club"] [role-2-style:"SUCCESS"] [role-3:@VIP] [role-3-text:"VIP Access"] [role-3-style:"DANGER"]
  • Creates three buttons:
    1. Book Club: Assigns the @Reader role with a blue button labeled "Book Club."
    2. Art Club: Assigns the @Artist role with a green button labeled "Art Club."
    3. VIP Access: Assigns the @VIP role with a red button labeled "VIP Access."

Managing Reaction Roles​

  • Maximum Buttons per Command: You can create up to 5 reaction roles in a single command.
  • Adding More Buttons: If you need more than 5 roles, you can run the command multiple times. Each execution creates a new row of buttons in the same message.

Button Styles​

Button styles let you visually differentiate between roles:

  • Primary: Blue
  • Secondary: Gray
  • Success: Green
  • Danger: Red

Notes​

  • Button text and styles are optional but recommended for clarity.
  • The bot requires appropriate permissions to manage roles and send messages.

By using the Reaction Roles feature, you can create an interactive and user-friendly way for your members to assign roles, making role management efficient and engaging for your community.